RMS Config API
Error Codes
| Error Code | Http Status Code | API Endpoint / Resource | Reason for Error | Error Cause |
|---|---|---|---|---|
| RMS-400-01 | 400 - Bad Request | PUT services/{productId}/lan/dhcpIp PUT services/{productId}/lan/ethernetPorts/{ethernetPortIndex} PUT services/{productId}/lan/staticIps PUT services/{productId}/security/credentials PUT services/{productId}/security/firewall PUT services/{productId}/security/portForwardingRules PUT services/{productId}/voice/{voiceProfileIndex} PUT services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex} PUT services/{productId}/wan PUT services/{productId}/wifi/{wifiPortIndex} |
RAML validation failure | A field value provided in the PUT request object has failed RAML validation checking. |
| N/A | 401 - Invalid Client | GET version GET services/{productId} GET services/{productId}/lan/dhcpIp GET services/{productId}/lan/ethernetPorts GET services/{productId}/lan/hosts GET services/{productId}/lan/staticIps GET services/{productId}/security/firewall GET services/{productId}/security/portForwardingRules GET services/{productId}/voice GET services/{productId}/wan GET services/{productId}/wifi POST services/{productId}/reboot POST services/{productId}/factoryReset POST services/{productId}/lan/ethernetPorts/{ethernetPortIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/reconfigure POST services/{productId}/voice/{voiceProfileIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex}/reset POST services/{productId}/wifi/{wifiPortIndex}/reset PUT services/{productId}/lan/dhcpIp PUT services/{productId}/lan/ethernetPorts/{ethernetPortIndex} PUT services/{productId}/lan/staticIps PUT services/{productId}/security/credentials PUT services/{productId}/security/firewall PUT services/{productId}/security/portForwardingRules PUT services/{productId}/voice/{voiceProfileIndex} PUT services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex} PUT services/{productId}/wan PUT services/{productId}/wifi/{wifiPortIndex} |
Client Application not approved for access to API. | An unauthorised Client Application has tried to access a protected API resource. |
| RMS-403-01 | 403 - Forbidden | GET version GET services/{productId} GET services/{productId}/lan/dhcpIp GET services/{productId}/lan/ethernetPorts GET services/{productId}/lan/hosts GET services/{productId}/lan/staticIps GET services/{productId}/security/firewall GET services/{productId}/security/portForwardingRules GET services/{productId}/voice GET services/{productId}/wan GET services/{productId}/wifi POST services/{productId}/reboot POST services/{productId}/factoryReset POST services/{productId}/lan/ethernetPorts/{ethernetPortIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/reconfigure POST services/{productId}/voice/{voiceProfileIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex}/reset POST services/{productId}/wifi/{wifiPortIndex}/reset PUT services/{productId}/lan/dhcpIp PUT services/{productId}/lan/ethernetPorts/{ethernetPortIndex} PUT services/{productId}/lan/staticIps PUT services/{productId}/security/credentials PUT services/{productId}/security/firewall PUT services/{productId}/security/portForwardingRules PUT services/{productId}/voice/{voiceProfileIndex} PUT services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex} PUT services/{productId}/wan PUT services/{productId}/wifi/{wifiPortIndex} |
Chorus Authorization API approval and configuration incomplete. | Client App approved by API Manager but not setup in Authorization API. Chorus Authorization API approval and configuration required. |
| –PT-005 | 404 - Not Found | GET version GET services/{productId} GET services/{productId}/lan/dhcpIp GET services/{productId}/lan/ethernetPorts GET services/{productId}/lan/hosts GET services/{productId}/lan/staticIps GET services/{productId}/security/firewall GET services/{productId}/security/portForwardingRules GET services/{productId}/voice GET services/{productId}/wan GET services/{productId}/wifi POST services/{productId}/reboot POST services/{productId}/factoryReset POST services/{productId}/lan/ethernetPorts/{ethernetPortIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/reconfigure POST services/{productId}/voice/{voiceProfileIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex}/reset POST services/{productId}/wifi/{wifiPortIndex}/reset PUT services/{productId}/lan/dhcpIp PUT services/{productId}/lan/ethernetPorts/{ethernetPortIndex} PUT services/{productId}/lan/staticIps PUT services/{productId}/security/credentials PUT services/{productId}/security/firewall PUT services/{productId}/security/portForwardingRules PUT services/{productId}/voice/{voiceProfileIndex} PUT services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex} PUT services/{productId}/wan PUT services/{productId}/wifi/{wifiPortIndex} |
Product ID not found. | Product not yet configured in FSOM for this RSP. |
| RMS-405-01 | 405 - Not Allowed | Any request NOT in this list: GET services/{productId}/lan/dhcpIp GET services/{productId}/lan/ethernetPorts GET services/{productId}/lan/hosts GET services/{productId}/lan/staticIps GET services/{productId}/security/firewall GET services/{productId}/security/portForwardingRules GET services/{productId}/voice GET services/{productId}/wan GET services/{productId}/wifi POST services/{productId}/reboot POST services/{productId}/factoryReset POST services/{productId}/lan/ethernetPorts/{ethernetPortIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/reconfigure POST services/{productId}/voice/{voiceProfileIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex}/reset POST services/{productId}/wifi/{wifiPortIndex}/reset PUT services/{productId}/lan/dhcpIp PUT services/{productId}/lan/ethernetPorts/{ethernetPortIndex} PUT services/{productId}/lan/staticIps PUT services/{productId}/security/credentials PUT services/{productId}/security/firewall PUT services/{productId}/security/portForwardingRules PUT services/{productId}/voice/{voiceProfileIndex} PUT services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex} PUT services/{productId}/wan PUT services/{productId}/wifi/{wifiPortIndex} |
API resource request is not permitted | The resource request is not supported |
| RMS-406-01 | 406 - Not Acceptable | Any request NOT in this list: GET version GET services/{productId} GET services/{productId}/lan/dhcpIp GET services/{productId}/lan/ethernetPorts GET services/{productId}/lan/hosts GET services/{productId}/lan/staticIps GET services/{productId}/security/firewall GET services/{productId}/security/portForwardingRules GET services/{productId}/voice GET services/{productId}/wan GET services/{productId}/wifi POST services/{productId}/reboot POST services/{productId}/factoryReset POST services/{productId}/lan/ethernetPorts/{ethernetPortIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/reconfigure POST services/{productId}/voice/{voiceProfileIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex}/reset POST services/{productId}/wifi/{wifiPortIndex}/reset PUT services/{productId}/lan/dhcpIp PUT services/{productId}/lan/ethernetPorts/{ethernetPortIndex} PUT services/{productId}/lan/staticIps PUT services/{productId}/security/credentials PUT services/{productId}/security/firewall PUT services/{productId}/security/portForwardingRules PUT services/{productId}/voice/{voiceProfileIndex} PUT services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex} PUT services/{productId}/wan PUT services/{productId}/wifi/{wifiPortIndex} |
API resource request not acceptable | |
| RMS-415-01 | 415 - Unsupported Media Type | Any request NOT in this list: GET version GET services/{productId} GET services/{productId}/lan/dhcpIp GET services/{productId}/lan/ethernetPorts GET services/{productId}/lan/hosts GET services/{productId}/lan/staticIps GET services/{productId}/security/firewall GET services/{productId}/security/portForwardingRules GET services/{productId}/voice GET services/{productId}/wan GET services/{productId}/wifi POST services/{productId}/reboot POST services/{productId}/factoryReset POST services/{productId}/lan/ethernetPorts/{ethernetPortIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/reconfigure POST services/{productId}/voice/{voiceProfileIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex}/reset POST services/{productId}/wifi/{wifiPortIndex}/reset PUT services/{productId}/lan/dhcpIp PUT services/{productId}/lan/ethernetPorts/{ethernetPortIndex} PUT services/{productId}/lan/staticIps PUT services/{productId}/security/credentials PUT services/{productId}/security/firewall PUT services/{productId}/security/portForwardingRules PUT services/{productId}/voice/{voiceProfileIndex} PUT services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex} PUT services/{productId}/wan PUT services/{productId}/wifi/{wifiPortIndex} PUT services/{productId}/wifi/{wifiPortIndex} |
API unsupported media type | |
| N/A | 429 - Too many requests | GET version GET services/{productId} GET services/{productId}/lan/dhcpIp GET services/{productId}/lan/ethernetPorts GET services/{productId}/lan/hosts GET services/{productId}/lan/staticIps GET services/{productId}/security/firewall GET services/{productId}/security/portForwardingRules GET services/{productId}/voice GET services/{productId}/wan GET services/{productId}/wifi POST services/{productId}/reboot POST services/{productId}/factoryReset POST services/{productId}/lan/ethernetPorts/{ethernetPortIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/reconfigure POST services/{productId}/voice/{voiceProfileIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex}/reset POST services/{productId}/wifi/{wifiPortIndex}/reset PUT services/{productId}/lan/dhcpIp PUT services/{productId}/lan/ethernetPorts/{ethernetPortIndex} PUT services/{productId}/lan/staticIps PUT services/{productId}/security/credentials PUT services/{productId}/security/firewall PUT services/{productId}/security/portForwardingRules PUT services/{productId}/voice/{voiceProfileIndex} PUT services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex} PUT services/{productId}/wan PUT services/{productId}/wifi/{wifiPortIndex} |
Too many resource requests sent by client | One of the resource request limits has been exceeded (Too many requests per minute or too many requests per hour). |
| RMS-500-01 | 500 - Internal server error | GET version GET services/{productId} GET services/{productId}/lan/dhcpIp GET services/{productId}/lan/ethernetPorts GET services/{productId}/lan/hosts GET services/{productId}/lan/staticIps GET services/{productId}/security/firewall GET services/{productId}/security/portForwardingRules GET services/{productId}/voice GET services/{productId}/wan GET services/{productId}/wifi POST services/{productId}/reboot POST services/{productId}/factoryReset POST services/{productId}/lan/ethernetPorts/{ethernetPortIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/reconfigure POST services/{productId}/voice/{voiceProfileIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex}/reset POST services/{productId}/wifi/{wifiPortIndex}/reset PUT services/{productId}/lan/dhcpIp PUT services/{productId}/lan/ethernetPorts/{ethernetPortIndex} PUT services/{productId}/lan/staticIps PUT services/{productId}/security/credentials PUT services/{productId}/security/firewall PUT services/{productId}/security/portForwardingRules PUT services/{productId}/voice/{voiceProfileIndex} PUT services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex} PUT services/{productId}/wan PUT services/{productId}/wifi/{wifiPortIndex} |
Remote Management Service API is unavailable | Remote Management Service API is unavailable. |
| RMS-500-02 | 500 - Unable to complete | GET services/{productId}/lan/dhcpIp GET services/{productId}/lan/ethernetPorts GET services/{productId}/lan/hosts GET services/{productId}/lan/staticIps GET services/{productId}/security/firewall GET services/{productId}/security/portForwardingRules GET services/{productId}/voice GET services/{productId}/wan GET services/{productId}/wifi POST services/{productId}/reboot POST services/{productId}/factoryReset POST services/{productId}/lan/ethernetPorts/{ethernetPortIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/reconfigure POST services/{productId}/voice/{voiceProfileIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex}/reset POST services/{productId}/wifi/{wifiPortIndex}/reset |
Unable to complete resource request due to device offline | The resource request requires the end-user device (ONT) to be online to complete successfully |
| RMS-501-01 | 501 - Not implemented | No examples at this time | Resource request has not been implemented | Development of resource request is incomplete |
| N/A | 502 - Bad Gateway | GET version GET services/{productId} GET services/{productId}/lan/dhcpIp GET services/{productId}/lan/ethernetPorts GET services/{productId}/lan/hosts GET services/{productId}/lan/staticIps GET services/{productId}/security/firewall GET services/{productId}/security/portForwardingRules GET services/{productId}/voice GET services/{productId}/wan GET services/{productId}/wifi POST services/{productId}/reboot POST services/{productId}/factoryReset POST services/{productId}/lan/ethernetPorts/{ethernetPortIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/reconfigure POST services/{productId}/voice/{voiceProfileIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex}/reset POST services/{productId}/wifi/{wifiPortIndex}/reset PUT services/{productId}/lan/dhcpIp PUT services/{productId}/lan/ethernetPorts/{ethernetPortIndex} PUT services/{productId}/lan/staticIps PUT services/{productId}/security/credentials PUT services/{productId}/security/firewall PUT services/{productId}/security/portForwardingRules PUT services/{productId}/voice/{voiceProfileIndex} PUT services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex} PUT services/{productId}/wan PUT services/{productId}/wifi/{wifiPortIndex} |
Bad gateway | Remote Management Service API is unavailable |
| N/A | 503 - System Unavailable | GET version GET services/{productId} GET services/{productId}/lan/dhcpIp GET services/{productId}/lan/ethernetPorts GET services/{productId}/lan/hosts GET services/{productId}/lan/staticIps GET services/{productId}/security/firewall GET services/{productId}/security/portForwardingRules GET services/{productId}/voice GET services/{productId}/wan GET services/{productId}/wifi POST services/{productId}/reboot POST services/{productId}/factoryReset POST services/{productId}/lan/ethernetPorts/{ethernetPortIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/reconfigure POST services/{productId}/voice/{voiceProfileIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex}/reset POST services/{productId}/wifi/{wifiPortIndex}/reset PUT services/{productId}/lan/dhcpIp PUT services/{productId}/lan/ethernetPorts/{ethernetPortIndex} PUT services/{productId}/lan/staticIps PUT services/{productId}/security/credentials PUT services/{productId}/security/firewall PUT services/{productId}/security/portForwardingRules PUT services/{productId}/voice/{voiceProfileIndex} PUT services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex} PUT services/{productId}/wan PUT services/{productId}/wifi/{wifiPortIndex} |
System unavailable | Remote Management Service API is unavailable |
| N/A | 504 - Gateway timeout | GET version GET services/{productId} GET services/{productId}/lan/dhcpIp GET services/{productId}/lan/ethernetPorts GET services/{productId}/lan/hosts GET services/{productId}/lan/staticIps GET services/{productId}/security/firewall GET services/{productId}/security/portForwardingRules GET services/{productId}/voice GET services/{productId}/wan GET services/{productId}/wifi POST services/{productId}/reboot POST services/{productId}/factoryReset POST services/{productId}/lan/ethernetPorts/{ethernetPortIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/reconfigure POST services/{productId}/voice/{voiceProfileIndex}/reset POST services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex}/reset POST services/{productId}/wifi/{wifiPortIndex}/reset PUT services/{productId}/lan/dhcpIp PUT services/{productId}/lan/ethernetPorts/{ethernetPortIndex} PUT services/{productId}/lan/staticIps PUT services/{productId}/security/credentials PUT services/{productId}/security/firewall PUT services/{productId}/security/portForwardingRules PUT services/{productId}/voice/{voiceProfileIndex} PUT services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex} PUT services/{productId}/wan PUT services/{productId}/wifi/{wifiPortIndex} |
Gateway timeout | Either Remote Management Service API is unavailable or the request has encountered a timeout issue |